Внешние интерфейсы – как ПО будет взаимодействовать с внешним миром

Внешние интерфейсы — точки интеграции системы с другими системами, пользователями или устройствами.

Что описывать

• Тип интерфейса: пользовательский (UI), API/протокол, файловый обмен, сообщения/очереди.

• Контракты: форматы данных, схемы, версии, коды ошибок.

• Безопасность: аутентификация/авторизация, шифрование, ограничения доступа.

• Нефункциональные: SLO (латентность/доступность), лимиты, объёмы, частоты.

• Зависимости: провайдеры, потребители, среда (DEV/TEST/PROD), версии.

Артефакты

• OpenAPI-Swagger/gRPC proto/GraphQL schema для API.

• UI: макеты/гайдлайны, соглашения по доступности.

• Интеграции по очередям: схемы сообщений, топики, QoS, ретраи.

Пример

• API публикации новости на нашем сайте

• Спецификация взаимодействия с платёжным агрегатором